<?xml version="1.0" encoding="iso-8859-1"?>

<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
  <head>
    <title>Module: ActiveBackground</title>
    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
    <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />

    <script language="JavaScript" type="text/javascript">
    // <![CDATA[

        function toggleSource( id )
        {
          var elem
          var link

          if( document.getElementById )
          {
            elem = document.getElementById( id )
            link = document.getElementById( "l_" + id )
          }
          else if ( document.all )
          {
            elem = eval( "document.all." + id )
            link = eval( "document.all.l_" + id )
          }
          else
            return false;

          if( elem.style.display == "block" )
          {
            elem.style.display = "none"
            link.innerHTML = "show source"
          }
          else
          {
            elem.style.display = "block"
            link.innerHTML = "hide source"
          }
        }

        function openCode( url )
        {
          window.open( url, "SOURCE_CODE", "width=400,height=400,scrollbars=yes" )
        }
      // ]]>
    </script>

  </head>

  <body>
  <table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'><tr>
  <td class="file-title"><span class="file-title-prefix">Module</span><br />ActiveBackground</td>
  <td align="right">
    <table cellspacing=0 cellpadding=2>
      <tr valign="top">
        <td>In:</td>
        <td>

<a href="../files/vendor/plugins/active_background/tasks/__/lib/active_background_rb.html">vendor/plugins/active_background/tasks/../lib/active_background.rb</a>
<a href="../files/vendor/plugins/active_background/tasks/__/lib/active_background/access_control_rb.html">vendor/plugins/active_background/tasks/../lib/active_background/access_control.rb</a>
<a href="../files/vendor/plugins/active_background/tasks/__/lib/active_background/archive_rb.html">vendor/plugins/active_background/tasks/../lib/active_background/archive.rb</a>
<a href="../files/vendor/plugins/active_background/tasks/__/lib/active_background/assistent_rb.html">vendor/plugins/active_background/tasks/../lib/active_background/assistent.rb</a>
<a href="../files/vendor/plugins/active_background/tasks/__/lib/active_background/client_rb.html">vendor/plugins/active_background/tasks/../lib/active_background/client.rb</a>
<a href="../files/vendor/plugins/active_background/tasks/__/lib/active_background/configuration_rb.html">vendor/plugins/active_background/tasks/../lib/active_background/configuration.rb</a>
<a href="../files/vendor/plugins/active_background/tasks/__/lib/active_background/database_rb.html">vendor/plugins/active_background/tasks/../lib/active_background/database.rb</a>
<a href="../files/vendor/plugins/active_background/tasks/__/lib/active_background/handler_rb.html">vendor/plugins/active_background/tasks/../lib/active_background/handler.rb</a>
<a href="../files/vendor/plugins/active_background/tasks/__/lib/active_background/job_rb.html">vendor/plugins/active_background/tasks/../lib/active_background/job.rb</a>
<a href="../files/vendor/plugins/active_background/tasks/__/lib/active_background/manager_rb.html">vendor/plugins/active_background/tasks/../lib/active_background/manager.rb</a>
<a href="../files/vendor/plugins/active_background/tasks/__/lib/active_background/middle_man_rb.html">vendor/plugins/active_background/tasks/../lib/active_background/middle_man.rb</a>
<a href="../files/vendor/plugins/active_background/tasks/__/lib/active_background/negotiator_rb.html">vendor/plugins/active_background/tasks/../lib/active_background/negotiator.rb</a>
<a href="../files/vendor/plugins/active_background/tasks/__/lib/active_background/server_rb.html">vendor/plugins/active_background/tasks/../lib/active_background/server.rb</a>
<a href="../files/vendor/plugins/active_background/tasks/__/lib/active_background/slave_rb.html">vendor/plugins/active_background/tasks/../lib/active_background/slave.rb</a>
<a href="../files/vendor/plugins/active_background/tasks/__/lib/active_background/handlers/cache_rb.html">vendor/plugins/active_background/tasks/../lib/active_background/handlers/cache.rb</a>
<a href="../files/vendor/plugins/active_background/tasks/__/lib/active_background/handlers/chef_rb.html">vendor/plugins/active_background/tasks/../lib/active_background/handlers/chef.rb</a>
<a href="../files/vendor/plugins/active_background/tasks/__/lib/active_background/jobs/queue_rb.html">vendor/plugins/active_background/tasks/../lib/active_background/jobs/queue.rb</a>
<a href="../files/vendor/plugins/active_background/tasks/__/lib/active_background/jobs/worker_rb.html">vendor/plugins/active_background/tasks/../lib/active_background/jobs/worker.rb</a>
        </td>
      </tr>
         </table>
        </td>
        </tr>
      </table>
 <!-- banner header -->

  <div id="bodyContent">
      <div id="content">

  <div class="description"><h2><a href="ActiveBackground/MiddleMan.html">MiddleMan</a></h2>
<p>
The client program to communicate with the server
</p>
<p>
<a href="ActiveBackground/MiddleMan.html">MiddleMan</a> allows you to
connect to the <a
href="ActiveBackground/Server.html">ActiveBackground::Server</a> to push
jobs and retrieve jobs. The jobs are managed by <a
href="ActiveBackground/Manager.html">ActiveBackground::Manager</a>.
</p>
<h2><a href="ActiveBackground/Client.html">Client</a></h2>
<p>
The <a href="ActiveBackground/Client.html">ActiveBackground::Client</a> is
responsible for initializing connection, managing the connection and
handeling local command cache if the server starts again. The client is
extended by <a
href="ActiveBackground/MiddleMan.html">ActiveBackground::MiddleMan</a> that
is responsible for communication between client and the local code (and
Handlers).
</p>
<p>
It is preferred not to use <a
href="ActiveBackground/Client.html">ActiveBackground::Client</a> directly
but to use <a href="ActiveBackground/MiddleMan.html">MiddleMan</a>, but if
you are not happy with <a
href="ActiveBackground/MiddleMan.html">ActiveBackground::MiddleMan</a>
extend <a href="ActiveBackground/Client.html">ActiveBackground::Client</a>.
You can use the IRB console to communicate with your server.
</p>
<pre>
  ./script/console
</pre>
<p>
Will open an IRB console with access to <a
href="ActiveBackground.html">ActiveBackground</a>.
</p>
<h2><a href="ActiveBackground/Server.html">Server</a></h2>
<p>
The server module is responsible for installing (as service), running,
stopping, detaching, and terminating the DRb server. Use one of the
supplied rake tasks to start the server like:
</p>
<pre>
  rake ActiveBackground::server
</pre>
<p>
But you can also use one of the following:
</p>
<pre>
  rake ActiveBackground::start
</pre>
<p>
You can pass parameters like -d to detach in unix and install/run as
service in windows. This allows the proces to run in the background and but
you can still terminate it by using the rake task:
</p>
<pre>
  rake ActiveBackground::stop
</pre>
<p>
It uses the PID stored in temp/ActiveBackground.pid to terminate the task.
</p>
</div>






  <div class="sectiontitle">Classes and Modules</div>

  Module <a href="ActiveBackground/DatabaseHandler.html" class="link">ActiveBackground::DatabaseHandler</a><br />
Class <a href="ActiveBackground/AccessControl.html" class="link">ActiveBackground::AccessControl</a><br />
Class <a href="ActiveBackground/AccessControlConfig.html" class="link">ActiveBackground::AccessControlConfig</a><br />
Class <a href="ActiveBackground/Archive.html" class="link">ActiveBackground::Archive</a><br />
Class <a href="ActiveBackground/Assistent.html" class="link">ActiveBackground::Assistent</a><br />
Class <a href="ActiveBackground/Base.html" class="link">ActiveBackground::Base</a><br />
Class <a href="ActiveBackground/Cache.html" class="link">ActiveBackground::Cache</a><br />
Class <a href="ActiveBackground/Chef.html" class="link">ActiveBackground::Chef</a><br />
Class <a href="ActiveBackground/Client.html" class="link">ActiveBackground::Client</a><br />
Class <a href="ActiveBackground/Configuration.html" class="link">ActiveBackground::Configuration</a><br />
Class <a href="ActiveBackground/Database.html" class="link">ActiveBackground::Database</a><br />
Class <a href="ActiveBackground/DatabaseConfig.html" class="link">ActiveBackground::DatabaseConfig</a><br />
Class <a href="ActiveBackground/Handler.html" class="link">ActiveBackground::Handler</a><br />
Class <a href="ActiveBackground/Initializer.html" class="link">ActiveBackground::Initializer</a><br />
Class <a href="ActiveBackground/Job.html" class="link">ActiveBackground::Job</a><br />
Class <a href="ActiveBackground/Manager.html" class="link">ActiveBackground::Manager</a><br />
Class <a href="ActiveBackground/MiddleMan.html" class="link">ActiveBackground::MiddleMan</a><br />
Class <a href="ActiveBackground/MiddleManProxy.html" class="link">ActiveBackground::MiddleManProxy</a><br />
Class <a href="ActiveBackground/Negotiator.html" class="link">ActiveBackground::Negotiator</a><br />
Class <a href="ActiveBackground/Queue.html" class="link">ActiveBackground::Queue</a><br />
Class <a href="ActiveBackground/RailsConfig.html" class="link">ActiveBackground::RailsConfig</a><br />
Class <a href="ActiveBackground/Server.html" class="link">ActiveBackground::Server</a><br />
Class <a href="ActiveBackground/ServerConfig.html" class="link">ActiveBackground::ServerConfig</a><br />
Class <a href="ActiveBackground/Slave.html" class="link">ActiveBackground::Slave</a><br />
Class <a href="ActiveBackground/Worker.html" class="link">ActiveBackground::Worker</a><br />




</div>

  </div>

    </body>
</html>